/* ************************************************************************

   Copyright:

   License:

   Authors:

************************************************************************ */

/* ************************************************************************



************************************************************************ */

/**
* This class represents a mapscript legendObj class.
*
*/
qx.Class.define("mmclient.mapscript.LegendObj",
{
  extend : qx.core.Object,


  /*
  *****************************************************************************
     CONSTRUCTOR
  *****************************************************************************
  */

  construct : function() {
    qx.core.Object.call(this);
  },


  /*
  *****************************************************************************
     PROPERTIES
  *****************************************************************************
  */
  
  properties :
  {
    /**
    * Legend height.
    *
    * @type: {Integer}
    */
    height :
    {
      check : "Number",
      init : 0
    },

    /**
    * Legend background color.
    *
    * @type: {@link mmclient.mapscript.ColorObj}
    */
    imagecolor :
    {
      check : "Object",
      init : null
    },

    /**
    * Width in pixels of legend keys.
    *
    * @type: {Integer}
    */
    keysizex :
    {
      check : "Number",
      init : 0
    },

    /**
    * Height in pixels of legend keys.
    *
    * @type: {Integer}
    */
    keysizey :
    {
      check : "Number",
      init : 0
    },

    /**
    * Horizontal padding around keys in pixels.
    *
    * @type: {Integer}
    */
    keyspacingx :
    {
      check : "Number",
      init : 0
    },

    /**
    * Vertical padding around keys in pixels.
    *
    * @type: {Integer}
    */
    keyspacingy :
    {
      check : "Number",
      init : 0
    },

    /**
    * Legend label.
    *
    * @type: {@link mmclient.mapscript.LabelObj}
    */
    label :
    {
      check : "Object",
      init : null
    },

    /**
    * Reference to parent mapObj.
    *
    * @type: {@link mapmedley.mapscript.MapObj}
    */
    map :
    {
      check : "Object",
      init : null
    },

    /**
    * Key outline color.
    *
    * @type: {@link mmclient.mapscript.ColorObj}
    */
    outlinecolor :
    {
      check : "Object",
      init : null
    },

    /**
    * MS_UL, MS_UC, MS_UR, MS_LL, MS_LC, or MS_LR.
    *
    * @type: {Integer}
    */
    position :
    {
      check : "Number",
      init : 0
    },

    /**
    * MS_TRUE or MS_FALSE.
    *
    * @type: {Integer}
    */
    postlabelcache :
    {
      check : "Number",
      init : 0
    },

    /**
    * MS_ON, MS_OFF, or MS_EMBED.
    *
    * @type: {Integer}
    */
    status :
    {
      check : "Number",
      init : 0
    },

    /**
    * Path to template file.
    *
    * @type: {String}
    */
    template :
    {
      check : "String",
      init : ""
    },

    /**
    * Legend width.
    *
    * @type: {Integer}
    */
    width :
    {
      check : "Number",
      init : 0
    }
  }
});
